home *** CD-ROM | disk | FTP | other *** search
/ MacHack 2000 / MacHack 2000.toast / pc / The Hacks / MacHacksBug / Python 1.5.2c1 / Mac / Lib / lib-toolbox / aetools.py < prev    next >
Encoding:
Python Source  |  2000-06-23  |  7.4 KB  |  272 lines
  1. """Tools for use in AppleEvent clients and servers.
  2.  
  3. pack(x) converts a Python object to an AEDesc object
  4. unpack(desc) does the reverse
  5.  
  6. packevent(event, parameters, attributes) sets params and attrs in an AEAppleEvent record
  7. unpackevent(event) returns the parameters and attributes from an AEAppleEvent record
  8.  
  9. Plus...  Lots of classes and routines that help representing AE objects,
  10. ranges, conditionals, logicals, etc., so you can write, e.g.:
  11.  
  12.     x = Character(1, Document("foobar"))
  13.  
  14. and pack(x) will create an AE object reference equivalent to AppleScript's
  15.  
  16.     character 1 of document "foobar"
  17.  
  18. Some of the stuff that appears to be exported from this module comes from other
  19. files: the pack stuff from aepack, the objects from aetypes.
  20.  
  21. """
  22.  
  23.  
  24. from types import *
  25. import AE
  26. import AppleEvents
  27. import MacOS
  28. import sys
  29.  
  30. from aetypes import *
  31. from aepack import pack, unpack, coerce, AEDescType
  32.  
  33. Error = 'aetools.Error'
  34.  
  35. # Special code to unpack an AppleEvent (which is *not* a disguised record!)
  36. # Note by Jack: No??!? If I read the docs correctly it *is*....
  37.  
  38. aekeywords = [
  39.     'tran',
  40.     'rtid',
  41.     'evcl',
  42.     'evid',
  43.     'addr',
  44.     'optk',
  45.     'timo',
  46.     'inte',    # this attribute is read only - will be set in AESend
  47.     'esrc',    # this attribute is read only
  48.     'miss',    # this attribute is read only
  49.     'from'    # new in 1.0.1
  50. ]
  51.  
  52. def missed(ae):
  53.     try:
  54.         desc = ae.AEGetAttributeDesc('miss', 'keyw')
  55.     except AE.Error, msg:
  56.         return None
  57.     return desc.data
  58.  
  59. def unpackevent(ae):
  60.     parameters = {}
  61.     try:
  62.         dirobj = ae.AEGetParamDesc('----', '****')
  63.     except AE.Error:
  64.         pass
  65.     else:
  66.         parameters['----'] = unpack(dirobj)
  67.         del dirobj
  68.     while 1:
  69.         key = missed(ae)
  70.         if not key: break
  71.         parameters[key] = unpack(ae.AEGetParamDesc(key, '****'))
  72.     attributes = {}
  73.     for key in aekeywords:
  74.         try:
  75.             desc = ae.AEGetAttributeDesc(key, '****')
  76.         except (AE.Error, MacOS.Error), msg:
  77.             if msg[0] != -1701 and msg[0] != -1704:
  78.                 raise sys.exc_type, sys.exc_value
  79.             continue
  80.         attributes[key] = unpack(desc)
  81.     return parameters, attributes
  82.  
  83. def packevent(ae, parameters = {}, attributes = {}):
  84.     for key, value in parameters.items():
  85.         ae.AEPutParamDesc(key, pack(value))
  86.     for key, value in attributes.items():
  87.         ae.AEPutAttributeDesc(key, pack(value))
  88.  
  89. #
  90. # Support routine for automatically generated Suite interfaces
  91. # These routines are also useable for the reverse function.
  92. #
  93. def keysubst(arguments, keydict):
  94.     """Replace long name keys by their 4-char counterparts, and check"""
  95.     ok = keydict.values()
  96.     for k in arguments.keys():
  97.         if keydict.has_key(k):
  98.             v = arguments[k]
  99.             del arguments[k]
  100.             arguments[keydict[k]] = v
  101.         elif k != '----' and k not in ok:
  102.             raise TypeError, 'Unknown keyword argument: %s'%k
  103.             
  104. def enumsubst(arguments, key, edict):
  105.     """Substitute a single enum keyword argument, if it occurs"""
  106.     if not arguments.has_key(key):
  107.         return
  108.     v = arguments[key]
  109.     ok = edict.values()
  110.     if edict.has_key(v):
  111.         arguments[key] = edict[v]
  112.     elif not v in ok:
  113.         raise TypeError, 'Unknown enumerator: %s'%v
  114.         
  115. def decodeerror(arguments):
  116.     """Create the 'best' argument for a raise MacOS.Error"""
  117.     errn = arguments['errn']
  118.     err_a1 = errn
  119.     if arguments.has_key('errs'):
  120.         err_a2 = arguments['errs']
  121.     else:
  122.         err_a2 = MacOS.GetErrorString(errn)
  123.     if arguments.has_key('erob'):
  124.         err_a3 = arguments['erob']
  125.     else:
  126.         err_a3 = None
  127.     
  128.     return (err_a1, err_a2, err_a3)
  129.  
  130. class TalkTo:
  131.     """An AE connection to an application"""
  132.     
  133.     def __init__(self, signature, start=0, timeout=0):
  134.         """Create a communication channel with a particular application.
  135.         
  136.         Addressing the application is done by specifying either a
  137.         4-byte signature, an AEDesc or an object that will __aepack__
  138.         to an AEDesc.
  139.         """
  140.         self.target_signature = None
  141.         if type(signature) == AEDescType:
  142.             self.target = signature
  143.         elif type(signature) == InstanceType and hasattr(signature, '__aepack__'):
  144.             self.target = signature.__aepack__()
  145.         elif type(signature) == StringType and len(signature) == 4:
  146.             self.target = AE.AECreateDesc(AppleEvents.typeApplSignature, signature)
  147.             self.target_signature = signature
  148.         else:
  149.             raise TypeError, "signature should be 4-char string or AEDesc"
  150.         self.send_flags = AppleEvents.kAEWaitReply
  151.         self.send_priority = AppleEvents.kAENormalPriority
  152.         if timeout:
  153.             self.send_timeout = timeout
  154.         else:
  155.             self.send_timeout = AppleEvents.kAEDefaultTimeout
  156.         if start:
  157.             self.start()
  158.         
  159.     def start(self):
  160.         """Start the application, if it is not running yet"""
  161.         _launch(self.target_signature)
  162.             
  163.     def newevent(self, code, subcode, parameters = {}, attributes = {}):
  164.         """Create a complete structure for an apple event"""
  165.         
  166.         event = AE.AECreateAppleEvent(code, subcode, self.target,
  167.                     AppleEvents.kAutoGenerateReturnID, AppleEvents.kAnyTransactionID)
  168.         packevent(event, parameters, attributes)
  169.         return event
  170.     
  171.     def sendevent(self, event):
  172.         """Send a pre-created appleevent, await the reply and unpack it"""
  173.         
  174.         reply = event.AESend(self.send_flags, self.send_priority,
  175.                                   self.send_timeout)
  176.         parameters, attributes = unpackevent(reply)
  177.         return reply, parameters, attributes
  178.         
  179.     def send(self, code, subcode, parameters = {}, attributes = {}):
  180.         """Send an appleevent given code/subcode/pars/attrs and unpack the reply"""
  181.         return self.sendevent(self.newevent(code, subcode, parameters, attributes))
  182.     
  183.     #
  184.     # The following events are somehow "standard" and don't seem to appear in any
  185.     # suite...
  186.     #
  187.     def activate(self):
  188.         """Send 'activate' command"""
  189.         self.send('misc', 'actv')
  190.  
  191.     def _get(self, _object, as=None, _attributes={}):
  192.         """_get: get data from an object
  193.         Required argument: the object
  194.         Keyword argument _attributes: AppleEvent attribute dictionary
  195.         Returns: the data
  196.         """
  197.         _code = 'core'
  198.         _subcode = 'getd'
  199.  
  200.         _arguments = {'----':_object}
  201.         if as:
  202.             _arguments['rtyp'] = mktype(as)
  203.  
  204.         _reply, _arguments, _attributes = self.send(_code, _subcode,
  205.                 _arguments, _attributes)
  206.         if _arguments.has_key('errn'):
  207.             raise Error, decodeerror(_arguments)
  208.  
  209.         if _arguments.has_key('----'):
  210.             return _arguments['----']
  211.  
  212. # Tiny Finder class, for local use only
  213.  
  214. class _miniFinder(TalkTo):
  215.     def open(self, _object, _attributes={}, **_arguments):
  216.         """open: Open the specified object(s)
  217.         Required argument: list of objects to open
  218.         Keyword argument _attributes: AppleEvent attribute dictionary
  219.         """
  220.         _code = 'aevt'
  221.         _subcode = 'odoc'
  222.  
  223.         if _arguments: raise TypeError, 'No optional args expected'
  224.         _arguments['----'] = _object
  225.  
  226.  
  227.         _reply, _arguments, _attributes = self.send(_code, _subcode,
  228.                 _arguments, _attributes)
  229.         if _arguments.has_key('errn'):
  230.             raise Error, decodeerror(_arguments)
  231.         # XXXX Optionally decode result
  232.         if _arguments.has_key('----'):
  233.             return _arguments['----']
  234. #pass
  235.     
  236. _finder = _miniFinder('MACS')
  237.  
  238. def _launch(appfile):
  239.     """Open a file thru the finder. Specify file by name or fsspec"""
  240.     _finder.open(_application_file(('ID  ', appfile)))
  241.  
  242.  
  243. class _application_file(ComponentItem):
  244.     """application file - An application's file on disk"""
  245.     want = 'appf'
  246.     
  247. _application_file._propdict = {
  248. }
  249. _application_file._elemdict = {
  250. }
  251.     
  252. # Test program
  253. # XXXX Should test more, really...
  254.  
  255. def test():
  256.     target = AE.AECreateDesc('sign', 'quil')
  257.     ae = AE.AECreateAppleEvent('aevt', 'oapp', target, -1, 0)
  258.     print unpackevent(ae)
  259.     raw_input(":")
  260.     ae = AE.AECreateAppleEvent('core', 'getd', target, -1, 0)
  261.     obj = Character(2, Word(1, Document(1)))
  262.     print obj
  263.     print repr(obj)
  264.     packevent(ae, {'----': obj})
  265.     params, attrs = unpackevent(ae)
  266.     print params['----']
  267.     raw_input(":")
  268.  
  269. if __name__ == '__main__':
  270.     test()
  271.     sys.exit(1)
  272.